docs: replace all <examples> with markdown headings
authorWilliam Jon McCann <william.jon.mccann@gmail.com>
Tue, 4 Feb 2014 21:57:57 +0000 (16:57 -0500)
committerWilliam Jon McCann <william.jon.mccann@gmail.com>
Tue, 4 Feb 2014 21:58:54 +0000 (16:58 -0500)
32 files changed:
gdk/gdkapplaunchcontext.c
gdk/gdkdevicemanager.c
gdk/gdkdisplay.c
gdk/gdkdisplaymanager.c
gdk/gdkpango.c
gtk/gtkaccellabel.c
gtk/gtkapplication.c
gtk/gtkapplicationwindow.c
gtk/gtkdrawingarea.c
gtk/gtkeditable.c
gtk/gtkfilechooser.c
gtk/gtkfilechooserbutton.c
gtk/gtkfilechooserdialog.c
gtk/gtkimage.c
gtk/gtklevelbar.c
gtk/gtkmain.c
gtk/gtkmenu.c
gtk/gtkpagesetup.c
gtk/gtkpaned.c
gtk/gtkprintcontext.c
gtk/gtkprintoperation.c
gtk/gtkradiobutton.c
gtk/gtkradiomenuitem.c
gtk/gtkrecentchooserdialog.c
gtk/gtksearchbar.c
gtk/gtksocket.c
gtk/gtkspinbutton.c
gtk/gtkstylecontext.c
gtk/gtktogglebutton.c
gtk/gtktreemodel.c
gtk/gtktreemodelsort.c
gtk/gtkwidgetpath.c

index 22e517790c3c709cb301227709479c58e0336e08..f84367da5565c6b16407a5058b316d1fa56c38ad 100644 (file)
@@ -34,8 +34,9 @@
  * handles launching an application in a graphical context. It provides
  * startup notification and allows to launch applications on a specific
  * screen or workspace.
- * <example>
- * <title>Launching an application</title>
+ *
+ * ## Launching an application
+ *
  * |[<!-- language="C" -->
  * GdkAppLaunchContext *context;
  *
@@ -49,7 +50,6 @@
  *
  * g_object_unref (context);
  * ]|
- * </example>
  */
 
 
index cb2f227d7ed6faa8f4a8065dbcd3c8dc42360fef..ace175d0e5884aeda26d33d9c4e7ad2a1558d46b 100644 (file)
@@ -77,7 +77,8 @@
  * be controlling each of these virtual devices. Physical devices may also
  * be "floating", which means they are not attached to any virtual device.
  *
- * <example><title>Master and slave devices</title>
+ * ## Master and slave devices
+ *
  * <screen>
  * carlos@sacarino:~$ xinput list
  * ⎡ Virtual core pointer                          id=2    [master pointer  (3)]
@@ -96,7 +97,6 @@
  *     ↳ AT Translated Set 2 keyboard              id=12   [slave  keyboard (3)]
  *     ↳ ThinkPad Extra Buttons                    id=15   [slave  keyboard (3)]
  * </screen>
- * </example>
  *
  * By default, GDK will automatically listen for events coming from all
  * master devices, setting the #GdkDevice for all events coming from input
index 39f310e7c8a8a8c75fb9ae54d07fd6181262c198..c7cfabdfb4de6d234e3361cd67adce65098337fb 100644 (file)
@@ -2107,8 +2107,8 @@ static GQueue gdk_error_traps = G_QUEUE_INIT;
  * You can use gdk_x11_display_error_trap_push() to ignore errors
  * on only a single display.
  *
-* <example>
- * <title>Trapping an X error</title>
+ * ## Trapping an X error
+ *
  * |[<!-- language="C" -->
  * gdk_error_trap_push (<!-- -->);
  *
@@ -2120,7 +2120,6 @@ static GQueue gdk_error_traps = G_QUEUE_INIT;
  *    // ... Handle the error here ...
  *  }
  * ]|
- * </example>
  */
 void
 gdk_error_trap_push (void)
index 98700373d39fac42d226477d90035deb8862f3c9..193164a68cbfa7ffaac0fcd5b63d19653a8b2e98 100644 (file)
@@ -85,8 +85,8 @@
  * you are building your application against. At runtime, use type-check
  * macros like GDK_IS_X11_DISPLAY() to find out which backend is in use:
  *
- * <example id="backend-specific">
- * <title>Backend-specific code</title>
+ * ## Backend-specific code ## {#backend-specific}
+ *
  * |[<!-- language="C" -->
  * #ifdef GDK_WINDOWING_X11
  *   if (GDK_IS_X11_DISPLAY (display))
  * #endif
  *   g_error ("Unsupported GDK backend");
  * ]|
- * </example>
  */
 
 
index 9b2b8542cdc1519d0edfa28c6ef20e4ead4636b1..b1d4eca2c7199f6de5fb37f7cb6c276051853d47 100644 (file)
@@ -49,8 +49,9 @@
  *
  * Rendering a Pango layout is done most simply with pango_cairo_show_layout();
  * you can also draw pieces of the layout with pango_cairo_show_layout_line().
- * <example id="rotated-example">
- * <title>Draw transformed text with Pango and cairo</title>
+ *
+ * ## Draw transformed text with Pango and cairo ## {#rotated-example}
+ *
  * <!-- Note that this example is basically the same as
  *      demos/gtk-demo/rotated_text.c -->
  * |[<!-- language="C" -->
  * g_object_unref (layout);
  * g_object_unref (context);
  * ]|
- * </example>
+ *
  * <figure>
  *   <title>Output of <xref linkend="rotated-example"/></title>
  *   <graphic fileref="rotated-text.png" format="PNG"/>
index 5be7750a08ea23b38ba393cae950261b4374edbe..1b4cb77c87f73ca6c62b10c854898630b364f016 100644 (file)
@@ -65,8 +65,9 @@
  * set (see #GtkAccelFlags).
  * A #GtkAccelLabel can display multiple accelerators and even signal names,
  * though it is almost always used to display just one accelerator key.
- * <example>
- * <title>Creating a simple menu item with an accelerator key.</title>
+ *
+ * ## Creating a simple menu item with an accelerator key.
+ *
  * |[<!-- language="C" -->
  *   GtkWidget *save_item;
  *   GtkAccelGroup *accel_group;
@@ -87,7 +88,6 @@
  *   gtk_widget_add_accelerator (save_item, "activate", accel_group,
  *                               GDK_KEY_s, GDK_CONTROL_MASK, GTK_ACCEL_VISIBLE);
  * ]|
- * </example>
  */
 
 enum {
index 87cbf5daab218b2bcf0596f41415653b5b0044e5..e4cbea9c7c88ee3bef670737391eda38c059cac3 100644 (file)
  * <graphic fileref="bloatpad-xfce.png" format="PNG"/>
  * </figure>
  *
- * <example id="gtkapplication"><title>A simple application</title>
+ * ## A simple application ## {#gtkapplication}
+ *
  * |[<!-- language="C" -->
  * <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" parse="text" href="../../../../examples/bloatpad.c">
  *  <xi:fallback>FIXME: MISSING XINCLUDE CONTENT</xi:fallback>
  * </xi:include>
  * ]|
- * </example>
  *
  * GtkApplication optionally registers with a session manager
  * of the users session (if you set the #GtkApplication:register-session
index 9b795d12a24d2f31a7e462b31123160d1e51bc58..7b4679082ccc0648c5befdb605ef90115aa47d23 100644 (file)
@@ -78,7 +78,8 @@
  * also be shown as part of client-side window decorations, e.g. by
  * using gtk_header_bar_set_show_close_button().
  *
- * <example><title>A GtkApplicationWindow with a menubar</title>
+ * ## A GtkApplicationWindow with a menubar
+ *
  * |[<!-- language="C" -->
  * app = gtk_application_new ();
  *
  *
  * window = gtk_application_window_new (app);
  * ]|
- * </example>
  *
- * <example><title>Handling fallback yourself</title>
+ * ## Handling fallback yourself
+ *
  * |[<!-- language="C" -->
  * <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" parse="text" href="../../../../examples/sunny.c">
  *  <xi:fallback>FIXME: MISSING XINCLUDE CONTENT</xi:fallback>
index 50ff45abe50067c6e032a6b37eeaaa203e002ad8..79d58928cd25f45ed86c6b40b450e39791b95783 100644 (file)
@@ -60,8 +60,8 @@
  * background color before sending the expose event, and that
  * drawing is implicitly clipped to the exposed area.
  *
- * <example>
- * <title>Simple GtkDrawingArea usage</title>
+ * ## Simple GtkDrawingArea usage
+ *
  * |[<!-- language="C" -->
  * gboolean
  * draw_callback (GtkWidget *widget, cairo_t *cr, gpointer data)
@@ -91,7 +91,6 @@
  *   g_signal_connect (G_OBJECT (drawing_area), "draw",
  *                     G_CALLBACK (draw_callback), NULL);
  * ]|
- * </example>
  *
  * Draw signals are normally delivered when a drawing area first comes
  * onscreen, or when it's covered by another window and then uncovered.
index e57efdd63e777d20daec295968ed793b3137799b..a2bba6879ec7d3832662341e1dc9ca1250e94a1e 100644 (file)
@@ -37,8 +37,8 @@
  * the following handler to #GtkEditable::insert-text, an application
  * can convert all entry into a widget into uppercase.
  *
- * <example>
- * <title>Forcing entry to uppercase.</title>
+ * ## Forcing entry to uppercase.
+ *
  * |[<!-- language="C" -->
  * #include <ctype.h>;
  *
@@ -62,7 +62,6 @@
  *   g_free (result);
  * }
  * ]|
- * </example>
  */
 
 #include "config.h"
index 00d0c0c5698fc77d5cd4fb8e88e70006773dfa49..9aa044ba88b20dc2905371f63839fa4274efddbc 100644 (file)
@@ -321,8 +321,9 @@ gtk_file_chooser_default_init (GtkFileChooserInterface *iface)
    * dialog should be used, it should return
    * %GTK_FILE_CHOOSER_CONFIRMATION_CONFIRM. The following example
    * illustrates this.
-   * <example id="gtkfilechooser-confirmation">
-   * <title>Custom confirmation</title>
+   *
+   * ## Custom confirmation ## {#gtkfilechooser-confirmation}
+   *
    * |[<!-- language="C" -->
    * static GtkFileChooserConfirmation
    * confirm_overwrite_callback (GtkFileChooser *chooser, gpointer data)
@@ -354,7 +355,6 @@ gtk_file_chooser_default_init (GtkFileChooserInterface *iface)
    *
    * gtk_widget_destroy (chooser);
    * ]|
-   * </example>
    *
    * Returns: a #GtkFileChooserConfirmation value that indicates which
    *  action to take after emitting the signal.
index c639b71804f889d5868a7b86ad4f9902d770b590..dc448968b72d9df228df494bde58e2d14bdb53ec 100644 (file)
@@ -70,8 +70,8 @@
  * that button.  This widget does not support setting the
  * #GtkFileChooser:select-multiple property to %TRUE.
  *
- * <example>
- * <title>Create a button to let the user select a file in /etc</title>
+ * ## Create a button to let the user select a file in /etc
+ *
  * |[<!-- language="C" -->
  * {
  *   GtkWidget *button;
@@ -82,7 +82,6 @@
  *                                        "/etc");
  * }
  * ]|
- * </example>
  *
  * The #GtkFileChooserButton supports the #GtkFileChooserAction<!-- -->s
  * %GTK_FILE_CHOOSER_ACTION_OPEN and %GTK_FILE_CHOOSER_ACTION_SELECT_FOLDER.
index c52bc9614153b23a7c3373cc0b80643f2213acf3..a3efe171c52ca92e64f809f997f95039356a408d 100644 (file)
  * own.  Instead, you should use the functions that work on a
  * #GtkFileChooser.
  *
- * <example id="gtkfilechooser-typical-usage">
- * <title>Typical usage</title>
+ * ## Typical usage ## {#gtkfilechooser-typical-usage}
+ *
  * In the simplest of cases, you can the following code to use
  * #GtkFileChooserDialog to select a file for opening:
- * <para>
+ *
  * |[
  * GtkWidget *dialog;
  *
@@ -78,9 +78,9 @@
  *
  * gtk_widget_destroy (dialog);
  * ]|
- * </para>
+ *
  * To use a dialog for saving, you can use this:
- * <para>
+ *
  * |[
  * GtkWidget *dialog;
  *
  *
  * gtk_widget_destroy (dialog);
  * ]|
- * </para>
- * </example>
  *
- * ## Setting up a file chooser dialog
+ * ## Setting up a file chooser dialog ## {#gtkfilechooserdialog-setting-up}
  *
- * <para id="gtkfilechooserdialog-setting-up">
  * There are various cases in which you may need to use a #GtkFileChooserDialog:
- * </para>
  *
  * - To select a file for opening. Use #GTK_FILE_CHOOSER_ACTION_OPEN.
  *
  * i.e. when you are doing a Save As command and you already
  * have a file saved somewhere.
 
- * ## Response Codes
+ * ## Response Codes ## {#gtkfilechooserdialog-responses}
  *
- * <para id="gtkfilechooserdialog-response-codes">
  * #GtkFileChooserDialog inherits from #GtkDialog, so buttons that
  * go in its action area have response codes such as
  * #GTK_RESPONSE_ACCEPT and #GTK_RESPONSE_CANCEL.  For example, you
  * could call gtk_file_chooser_dialog_new() as follows:
+ *
  * |[
  * GtkWidget *dialog;
  *
  *                                       _("_Open"), GTK_RESPONSE_ACCEPT,
  *                                       NULL);
  * ]|
- * </para>
  *
- * <para id="gtkfilechooserdialog-responses">
  * This will create buttons for "Cancel" and "Open" that use stock
  * response identifiers from #GtkResponseType.  For most dialog
  * boxes you can use your own custom response codes rather than the
  * ones in #GtkResponseType, but #GtkFileChooserDialog assumes that
  * its "accept"-type action, e.g. an "Open" or "Save" button,
  * will have one of the following response codes:
- * </para>
+ *
  * - #GTK_RESPONSE_ACCEPT
  * - #GTK_RESPONSE_OK
  * - #GTK_RESPONSE_YES
index d69d8608da81bd5ab0852aeb5858328042442019..b430b625c64bc86ac668f441f562d71d6865b5ab 100644 (file)
@@ -74,8 +74,9 @@
  * so by default does not receive events. If you want to receive events
  * on the image, such as button clicks, place the image inside a
  * #GtkEventBox, then connect to the event signals on the event box.
- * <example>
- * <title>Handling button press events on a #GtkImage.</title>
+ *
+ * ## Handling button press events on a #GtkImage.
+ *
  * |[<!-- language="C" -->
  *   static gboolean
  *   button_press_callback (GtkWidget      *event_box,
  *     return image;
  *   }
  * ]|
- * </example>
  *
  * When handling events on the event box, keep in mind that coordinates
  * in the image may be different from event box coordinates due to
index ef8599fbf1356c388e61836a76db513677df10fe..d9e443f4d1704b86e7eb225b0faceead5fc93d74 100644 (file)
@@ -33,8 +33,8 @@
  * by default on the level bar: #GTK_LEVEL_BAR_OFFSET_LOW and
  * #GTK_LEVEL_BAR_OFFSET_HIGH, with values 0.25 and 0.75 respectively.
  *
- * <example>
- * <title>Adding a custom offset on the bar</title>
+ * ## Adding a custom offset on the bar
+ *
  * |[<!-- language="C" -->
  *
  * static GtkWidget *
@@ -66,7 +66,6 @@
  *   return level_bar;
  * }
  * ]|
- * </example>
  *
  * The default interval of values is between zero and one, but it's possible to
  * modify the interval using gtk_level_bar_set_min_value() and
index a2d019efecc36a0e3f31cd312dc7bcb2e98ac232..fe19e42655614a7dc41b21a0f1274ac7cba4e543 100644 (file)
@@ -53,8 +53,8 @@
  * #GtkFileChooserDialog. After a callback finishes, GTK+ will return to the
  * main loop and await more user input.
  *
- * <example>
- * <title>Typical main() function for a GTK+ application</title>
+ * ## Typical main() function for a GTK+ application
+ *
  * |[<!-- language="C" -->
  * int
  * main (int argc, char **argv)
@@ -81,7 +81,6 @@
  *   return 0;
  * }
  * ]|
- * </example>
  *
  * It's OK to use the GLib main loop directly instead of gtk_main(), though it
  * involves slightly more typing. See #GMainLoop in the GLib documentation.
@@ -1247,8 +1246,8 @@ gtk_main_quit (void)
  * This can be used to update the UI and invoke timeouts etc.
  * while doing some time intensive computation.
  *
- * <example>
- * <title>Updating the UI during a long computation</title>
+ * ## Updating the UI during a long computation
+ *
  * |[<!-- language="C" -->
  *  /&ast; computation going on... &ast;/
  *
@@ -1257,7 +1256,6 @@ gtk_main_quit (void)
  *
  *  /&ast; ...computation continued &ast;/
  * ]|
- * </example>
  *
  * Returns: %TRUE if any events are pending, %FALSE otherwise
  */
@@ -1804,8 +1802,8 @@ gtk_main_do_event (GdkEvent *event)
  * of a window. Of course you should not do this as the user expects
  * a reaction from clicking the close icon of the window...
  *
- * <example>
- * <title>A persistent window</title>
+ * ## A persistent window
+ *
  * |[<!-- language="C" -->
  * #include <gtk/gtk.h>
  *
@@ -1834,7 +1832,6 @@ gtk_main_do_event (GdkEvent *event)
  *   return 0;
  * }
  * ]|
- * </example>
  *
  * Returns: %TRUE
  */
index 909e27d3ed09b059ef55bca87c98c1c8653326b9..978b9dd729e5d663a00dc8baec6a8bca4681acf9 100644 (file)
  * gtk_menu_popup() function.  The example below shows how an application
  * can pop up a menu when the 3rd mouse button is pressed.  
  *
- * <example>
- * <title>Connecting the popup signal handler.</title>
+ * ## Connecting the popup signal handler.
+ *
  * |[<!-- language="C" -->
  *   /<!---->* connect our handler which will popup the menu *<!---->/
  *   g_signal_connect_swapped (window, "button_press_event",
  *     G_CALLBACK (my_popup_handler), menu);
  * ]|
- * </example>
  *
- * <example>
- * <title>Signal handler which displays a popup menu.</title>
+ * ## Signal handler which displays a popup menu.
+ *
  * |[<!-- language="C" -->
  * static gint
  * my_popup_handler (GtkWidget *widget, GdkEvent *event)
  *           return TRUE;
  *         }
  *     }
- * 
+ *
  *   return FALSE;
  * }
  * ]|
- * </example>
  */
 
 #include "config.h"
index 63fef1f8fc6cf5c3adedbc3f9d3e5c392db91aa5..fd003b282d372308bd1994c8e4a60bcef51f2adb 100644 (file)
@@ -48,8 +48,8 @@
  * or use gtk_print_run_page_setup_dialog() to show the page setup dialog
  * and receive the resulting page setup.
  *
- * <example>
- * <title>A page setup dialog</title>
+ * ## A page setup dialog
+ *
  * |[<!-- language="C" -->
  * static GtkPrintSettings *settings = NULL;
  * static GtkPageSetup *page_setup = NULL;
@@ -71,7 +71,6 @@
  *   page_setup = new_page_setup;
  * }
  * ]|
- * </example>
  *
  * Printing support was added in GTK+ 2.10.
  */
index 67931ac496b75f9cd5df1015feafdeb2d7b7bd27..856a5ba11565697b3c0796c878a10395872aa732 100644 (file)
@@ -73,8 +73,8 @@
  * The application can set the position of the slider as if it were set
  * by the user, by calling gtk_paned_set_position().
  *
- * <example>
- * <title>Creating a paned widget with minimum sizes.</title>
+ * ## Creating a paned widget with minimum sizes.
+ *
  * |[<!-- language="C" -->
  * GtkWidget *hpaned = gtk_paned_new (GTK_ORIENTATION_HORIZONTAL);
  * GtkWidget *frame1 = gtk_frame_new (NULL);
@@ -90,7 +90,6 @@
  * gtk_paned_pack2 (GTK_PANED (hpaned), frame2, FALSE, FALSE);
  * gtk_widget_set_size_request (frame2, 50, -1);
  * ]|
- * </example>
  */
 
 enum {
index 97d56e50c865772e5f5e89c2e86cae979cbf4947..fe3d4234d87082a9e63c5f7535bf97ca48af1b1c 100644 (file)
@@ -35,8 +35,8 @@
  * #GtkPrintOperation::end-print, #GtkPrintOperation::request-page-setup and
  * #GtkPrintOperation::draw-page signals on the #GtkPrintOperation.
  *
- * <example>
- * <title>Using GtkPrintContext in a #GtkPrintOperation::draw-page callback</title>
+ * ## Using GtkPrintContext in a #GtkPrintOperation::draw-page callback
+ *
  * |[<!-- language="C" -->
  * static void
  * draw_page (GtkPrintOperation *operation,
@@ -90,7 +90,6 @@
  *   g_object_unref (layout);
  * }
  * ]|
- * </example>
  *
  * Printing support was added in GTK+ 2.10.
  */
index daf0d37c50e45905e61a075f5b4e13c05a850548..30195a9a4e26075e4e6dbff9548e4de813c03f2a 100644 (file)
@@ -59,8 +59,8 @@
  * #GtkPrintOperation::draw-page, which you are supposed to catch
  * and render the page on the provided #GtkPrintContext using Cairo.
  *
- * <example>
- * <title>The high-level printing API</title>
+ * ## The high-level printing API
+ *
  * |[<!-- language="C" -->
  * static GtkPrintSettings *settings = NULL;
  *
@@ -91,7 +91,6 @@
  *   g_object_unref (print);
  * }
  * ]|
- * </example>
  *
  * By default GtkPrintOperation uses an external application to do
  * print preview. To implement a custom print preview, an application
index 8d62e01886d2f5a2efa8e9b42ff96242973bd6ae..fc7744403ccc0688f29b4beba1ba1a1b24e9bf88 100644 (file)
@@ -68,8 +68,8 @@
  * The group list does not need to be freed, as each #GtkRadioButton will remove
  * itself and its list item when it is destroyed.
  *
- * <example>
- * <title>How to create a group of two radio buttons.</title>
+ * ## How to create a group of two radio buttons.
+ *
  * |[<!-- language="C" -->
  * void create_radio_buttons (void) {
  *
@@ -96,7 +96,6 @@
  *    return;
  * }
  * ]|
- * </example>
  *
  * When an unselected button in the group is clicked the clicked button
  * receives the #GtkToggleButton::toggled signal, as does the previously
index 8d1fc0e98e226ac8424963e7ee68cfdcbd51fdcb..04c192aa8419cd0a9b81789632f95e3bf3238133 100644 (file)
@@ -46,8 +46,8 @@
  * The correct way to create a group of radio menu items is approximatively
  * this:
  *
- * <example>
- * <title>How to create a group of radio menu items.</title>
+ * ## How to create a group of radio menu items.
+ *
  * |[<!-- language="C" -->
  * GSList *group = NULL;
  * GtkWidget *item;
  *     gtk_check_menu_item_set_active (GTK_CHECK_MENU_ITEM (item), TRUE);
  * }
  * ]|
- * </example>
  */
 
-
 struct _GtkRadioMenuItemPrivate
 {
   GSList *group;
index cb0c2e1be4bd16718089a97b0cc5daa35af22163..8a5b98f61e4c9bab15d93d5ce75b7c9048994be2 100644 (file)
  * Note that #GtkRecentChooserDialog does not have any methods of its own.
  * Instead, you should use the functions that work on a #GtkRecentChooser.
  *
- * <example id="gtkrecentchooser-typical-usage">
- * <title>Typical usage</title>
+ * ## Typical usage ## {#gtkrecentchooser-typical-usage}
+ *
  * In the simplest of cases, you can use the following code to use
  * a #GtkRecentChooserDialog to select a recently used file:
+ *
  * |[<!-- language="C" -->
  * GtkWidget *dialog;
  *
@@ -68,7 +69,6 @@
  *
  * gtk_widget_destroy (dialog);
  * ]|
- * </example>
  *
  * Recently used files are supported since GTK+ 2.10.
  */
index 969d34b935220b4fa16852f81a3d7e8813eac781..dfde6887e2b3ec1ed4107c2de75a9ccd31d9c62c 100644 (file)
  * The following example shows you how to create a more complex search
  * entry.
  *
- * <example>
- * <title>Creating a search bar</title>
+ * ## Creating a search bar
+ *
  * |[<!-- language="C" -->
  * <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" parse="text" href="../../../../examples/search-bar.c">
  *  <xi:fallback>FIXME: MISSING XINCLUDE CONTENT</xi:fallback>
  * </xi:include>
  * ]|
- * </example>
  *
  * Since: 3.10
  */
@@ -166,8 +165,8 @@ preedit_changed_cb (GtkEntry  *entry,
  * gtk_search_bar_connect_entry(), this function will return
  * immediately with a warning.
  *
- * <example>
- * <title>Showing the search bar on key presses</title>
+ * ## Showing the search bar on key presses
+ *
  * |[<!-- language="C" -->
  * static gboolean
  * window_key_press_event_cb (GtkWidget *widget,
@@ -180,7 +179,6 @@ preedit_changed_cb (GtkEntry  *entry,
  * g_signal_connect (window, "key-press-event",
  *                   G_CALLBACK (window_key_press_event_cb), search_bar);
  * ]|
- * </example>
  *
  * Return value: %GDK_EVENT_STOP if the key press event resulted
  *     in text being entered in the search entry (and revealing
index ffd50c46d4bc684e444466e9a49992fc33e6ee9f..aab1a94de47ce8f43f4f26b0261238522a3ac35e 100644 (file)
@@ -68,8 +68,8 @@
  * Before using this function, the socket must have been realized,
  * and for hence, have been added to its parent.
  *
- * <example>
- * <title>Obtaining the window ID of a socket.</title>
+ * ## Obtaining the window ID of a socket.
+ *
  * |[<!-- language="C" -->
  * GtkWidget *socket = gtk_socket_new (<!-- -->);
  * gtk_widget_show (socket);
@@ -82,7 +82,6 @@
  * g_print ("The ID of the sockets window is %#x\n",
  *          gtk_socket_get_id (socket));
  * ]|
- * </example>
  *
  * Note that if you pass the window ID of the socket to another
  * process that will create a plug in the socket, you must make
index 5734d2cbe2be45c392828031b11e0392608a4d75..0a2c2b1c6873ccf098ce05f8947d970f52371abc 100644 (file)
@@ -78,8 +78,8 @@
  * See the #GtkAdjustment section for more details about an adjustment's
  * properties.
  *
- * <example>
- * <title>Using a GtkSpinButton to get an integer</title>
+ * ## Using a GtkSpinButton to get an integer
+ *
  * |[<!-- language="C" -->
  * /&ast; Provides a function to retrieve an integer value from a
  *  &ast; GtkSpinButton and creates a spin button to model percentage
  *   gtk_widget_show_all (window);
  * }
  * ]|
- * </example>
  *
- * <example>
- * <title>Using a GtkSpinButton to get a floating point value</title>
+ * ## Using a GtkSpinButton to get a floating point value
+ *
  * |[<!-- language="C" -->
  * /&ast; Provides a function to retrieve a floating point value from a
  *  &ast; GtkSpinButton, and creates a high precision spin button.
  *   gtk_widget_show_all (window);
  * }
  * ]|
- * </example>
  */
 
 struct _GtkSpinButtonPrivate
index 0117b441e304c1ec97cab6fe00df648b2ec292ea..247d1ca1c9189a74afa1b1a0ccad38540efe2eb5 100644 (file)
@@ -3706,10 +3706,9 @@ _gtk_style_context_get_cursor_color (GtkStyleContext *context,
  * on or off, and %GTK_STATE_FLAG_INCONSISTENT determines whether it
  * should be marked as undefined.
  *
- * <example>
- * <title>Typical checkmark rendering</title>
+ * Typical checkmark rendering:
+ *
  * ![](checks.png)
- * </example>
  *
  * Since: 3.0
  **/
@@ -3757,10 +3756,9 @@ gtk_render_check (GtkStyleContext *context,
  * state will determine whether the option is on or off, and
  * %GTK_STATE_FLAG_INCONSISTENT whether it should be marked as undefined.
  *
- * <example>
- * <title>Typical option mark rendering</title>
+ * Typical option mark rendering:
+ *
  * ![](options.png)
- * </example>
  *
  * Since: 3.0
  **/
@@ -3805,10 +3803,9 @@ gtk_render_option (GtkStyleContext *context,
  *
  * Renders an arrow pointing to @angle.
  *
- * <example>
- * <title>Typical arrow rendering at 0, 1&solidus;2 &pi;, &pi; and 3&solidus;2 &pi;</title>
+ * Typical arrow rendering at 0, 1&solidus;2 &pi;, &pi; and 3&solidus;2 &pi;:
+ *
  * ![](arrows.png)
- * </example>
  *
  * Since: 3.0
  **/
@@ -3857,13 +3854,12 @@ gtk_render_arrow (GtkStyleContext *context,
  *
  * Renders the background of an element.
  *
- * <example>
- * <title>Typical background rendering, showing the effect of
+ * Typical background rendering, showing the effect of
  * <parameter>background-image</parameter>,
  * <parameter>border-width</parameter> and
- * <parameter>border-radius</parameter></title>
+ * <parameter>border-radius</parameter>:
+ *
  * ![](background.png)
- * </example>
  *
  * Since: 3.0.
  **/
@@ -3907,15 +3903,13 @@ gtk_render_background (GtkStyleContext *context,
  *
  * Renders a frame around the rectangle defined by @x, @y, @width, @height.
  *
- * <example>
- * <title>Examples of frame rendering, showing the effect of
+ * Examples of frame rendering, showing the effect of
  * <parameter>border-image</parameter>,
  * <parameter>border-color</parameter>,
  * <parameter>border-width</parameter>,
- * <parameter>border-radius</parameter> and
- * junctions</title>
+ * <parameter>border-radius</parameter> and junctions:
+ *
  * ![](frames.png)
- * </example>
  *
  * Since: 3.0
  **/
@@ -3961,10 +3955,9 @@ gtk_render_frame (GtkStyleContext *context,
  * defined by @x, @y, @width, @height. The state %GTK_STATE_FLAG_ACTIVE
  * determines whether the expander is collapsed or expanded.
  *
- * <example>
- * <title>Typical expander rendering</title>
+ * Typical expander rendering:
+ *
  * ![](expanders.png)
- * </example>
  *
  * Since: 3.0
  **/
@@ -4007,10 +4000,10 @@ gtk_render_expander (GtkStyleContext *context,
  * @height: rectangle height
  *
  * Renders a focus indicator on the rectangle determined by @x, @y, @width, @height.
- * <example>
- * <title>Typical focus rendering</title>
+ *
+ * Typical focus rendering:
+ *
  * ![](focus.png)
- * </example>
  *
  * Since: 3.0
  **/
@@ -4134,10 +4127,9 @@ gtk_render_line (GtkStyleContext *context,
  * @width, @height. @orientation defines whether the slider is vertical
  * or horizontal.
  *
- * <example>
- * <title>Typical slider rendering</title>
+ * Typical slider rendering:
+ *
  * ![](sliders.png)
- * </example>
  *
  * Since: 3.0
  **/
@@ -4188,10 +4180,9 @@ gtk_render_slider (GtkStyleContext *context,
  * for %GTK_POS_TOP and %GTK_POS_BOTTOM gap sides, and Y coordinates for
  * %GTK_POS_LEFT and %GTK_POS_RIGHT.
  *
- * <example>
- * <title>Typical rendering of a frame with a gap</title>
+ * Typical rendering of a frame with a gap:
+ *
  * ![](frame-gap.png)
- * </example>
  *
  * Since: 3.0
  **/
@@ -4251,10 +4242,9 @@ gtk_render_frame_gap (GtkStyleContext *context,
  * defined by @x, @y, @width, @height. The side where the extension
  * connects to is defined by @gap_side.
  *
- * <example>
- * <title>Typical extension rendering</title>
+ * Typical extension rendering:
+ *
  * ![](extensions.png)
- * </example>
  *
  * Since: 3.0
  **/
@@ -4301,10 +4291,9 @@ gtk_render_extension (GtkStyleContext *context,
  * #GtkWindow<!-- -->'s resize grip), in the rectangle
  * determined by @x, @y, @width, @height.
  *
- * <example>
- * <title>Handles rendered for the paned and grip classes</title>
+ * Handles rendered for the paned and grip classes:
+ *
  * ![](handles.png)
- * </example>
  *
  * Since: 3.0
  **/
index b43350b4843a3892f6c0562e68c7c9ba06289e68..11dc951712a5b707f1a363fbd6394212eaaf98fc 100644 (file)
@@ -58,8 +58,8 @@
  *
  * To simply switch the state of a toggle button, use gtk_toggle_button_toggled().
  *
- * <example>
- * <title>Creating two #GtkToggleButton widgets.</title>
+ * ## Creating two #GtkToggleButton widgets.
+ *
  * |[<!-- language="C" -->
  * void make_toggles (void) {
  *    GtkWidget *dialog, *toggle1, *toggle2;
@@ -85,7 +85,6 @@
  *    gtk_widget_show_all (dialog);
  * }
  * ]|
- * </example>
  */
 
 
index 931d9ff766ca141d9e96d99bbb40f456c559669b..f12309bf76010ebe4d7bcaf5af6b4006670881e5 100644 (file)
  * easier, the second is much more common, as you often get paths from
  * callbacks.
  *
- * <example>
- * <title>Acquiring a #GtkTreeIter-struct</title>
+ * ## Acquiring a #GtkTreeIter-struct
+ *
  * |[<!-- language="C" -->
  *  /&ast; Three ways of getting the iter pointing to the location &ast;/
  * GtkTreePath *path;
  * parent_iter = iter;
  * gtk_tree_model_iter_nth_child (model, &iter, &parent_iter, 5);
  * ]|
- * </example>
  *
  * This second example shows a quick way of iterating through a list
  * and getting a string and an integer from each row. The
  * shown, as it is specific to the #GtkListStore. For information on
  * how to write such a function, see the #GtkListStore documentation.
  *
- * <example>
- * <title>Reading data from a #GtkTreeModel</title>
+ * ## Reading data from a #GtkTreeModel
+ *
  * |[<!-- language="C" -->
  * enum
  * {
  *    row_count++;
  *  }
  * ]|
- * </example>
  *
  * The #GtkTreeModel interface contains two methods for reference
  * counting: gtk_tree_model_ref_node() and gtk_tree_model_unref_node().
index f545ae7eb3d5c6ea953fcc572c4cc5c3d46b396b..9d294e82b6ff52b4074e948e840a2983143773cb 100644 (file)
@@ -50,8 +50,8 @@
  * simply put the same model in each widget, then sorting the first would
  * sort the second.
  *
- * <example>
- * <title>Using a #GtkTreeModelSort</title>
+ * ## Using a #GtkTreeModelSort
+ *
  * |[<!-- language="C" -->
  * {
  *   GtkTreeView *tree_view1;
@@ -78,7 +78,6 @@
  *                                         COLUMN_1, GTK_SORT_DESCENDING);
  * }
  * ]|
- * </example>
  *
  * To demonstrate how to access the underlying child model from the sort
  * model, the next example will be a callback for the #GtkTreeSelection
@@ -86,8 +85,8 @@
  * from COLUMN_1 of the model.  We then modify the string, find the same
  * selected row on the child model, and change the row there.
  *
- * <example>
- * <title>Accessing the child model of in a selection changed callback</title>
+ * ## Accessing the child model of in a selection changed callback
+ *
  * |[<!-- language="C" -->
  * void
  * selection_changed (GtkTreeSelection *selection, gpointer data)
  *   g_free (modified_data);
  * }
  * ]|
- * </example>
  */
 
 
index 9bfa58e6e601a9c28eb4930d3ec05136a9c6d6a4..fa431da1972217e0b29752f0f335a817cecb0d95 100644 (file)
@@ -40,8 +40,9 @@
  * updated on widget hierarchy changes.
  *
  * The widget path generation is generally simple:
- * <example>
- * <title>Defining a button within a window</title>
+ *
+ * ## Defining a button within a window
+ *
  * |[<!-- language="C" -->
  * {
  *   GtkWidgetPath *path;
  *   gtk_widget_path_append_type (path, GTK_TYPE_BUTTON);
  * }
  * ]|
- * </example>
  *
  * Although more complex information, such as widget names, or
  * different classes (property that may be used by other widget
  * types) and intermediate regions may be included:
  *
- * <example>
- * <title>Defining the first tab widget in a notebook</title>
+ * ## Defining the first tab widget in a notebook
+ *
  * |[<!-- language="C" -->
  * {
  *   GtkWidgetPath *path;
@@ -73,7 +73,6 @@
  *   gtk_widget_path_iter_set_name (path, pos, "first tab label");
  * }
  * ]|
- * </example>
  *
  * All this information will be used to match the style information
  * that applies to the described widget.